My Docs
My BlogPython Data StructuresRepoFamily-Promise-Docs
Search…
Web-Dev-Hub-Docs
Home
Navigation
Tools
Tools
Showcase
Downloads
How To Configure Ubuntu
REPL.IT Compilations
Past Notes
Git
JavaScript
My Bash Commands
Programming Languages
Programming Languages
What is a Programming Language?
Python
Python
Install PIP
JavaScript
JavaScript
Writing Files
JS-Leetcode
Web Development Frameworks & Libraries
GRAPHQL
React
Jquery
GATSBY
Productivity
Productivity
Misc
Misc
GitGateway
Links
Bookmarks
Websites
Websites
Not My Websites:
Backend
Backend
Networking
Networks
Resources
Resources
Video Resources
General Knowledge
General Knowledge
Knowledge Bank
Finance
Finance
Finance Reference
Financial Trends
Science & Tech (Innovation)
Science & Tech
Articles
Reading
Reading
Social Media & Trends
Trends In Web Dev
FB-Dev-Open Source
IG-API
Docs
Docs
Code Editors & Tools
Vscode
Cool Stuff
Cool Observable Notebooks
Server-Side
GraphQL
Rest VS GraphQl
REST-API
Public APIs
WEB_DEV_TOOLS
Web Dev Tools
Cloudinary
Postman
Netlify
DS_ALGOS_BRAINTEASERS
A Quick Guide to Big-O Notation, Memoization, Tabulation, and Sorting Algorithms by Example
Free-Stuff
Free Stuff
Job-Search
Job Search
Outreach
General Comp Sci
Principles behind the Agile Manifesto
Blockchain & Crypto
Blockchain Basics
Data Structures & Interviewing
Data Structures
REACT_REVISITED
Modern React with Redux
WEBDEV-Bootcamp-Notes
🏫
Lambda
testing
Testing:
Medium-articles
My Articles
🖲
AI
Pytorch
🎙
Audio
Audio
Powered By GitBook
GRAPHQL

Gatsby (graphql)

This guide will help you get started using Netlify CMS and Gatsby.
To get up and running with Gatsby, you’ll need to have Node.js installed on your computer. Note: Gatsby's minimum supported Node.js version is Node 8.

Create a new Gatsby site

Let's create a new site using the default Gatsby Starter Blog. Run the following commands in the terminal, in the folder where you'd like to create the blog:
1
npm install -g gatsby-cli
2
gatsby new blog https://github.com/gatsbyjs/gatsby-starter-blog
3
cd blog
Copied!

Get to know Gatsby

In your favorite code editor, open up the code generated for your "Gatsby Starter Blog" site, and take a look at the content directory.
You will see that there are multiple Markdown files that represent blog posts. Open one .md file and you will see something like this:
1
---
2
title: New Beginnings
3
date: "2015-05-28T22:40:32.169Z"
4
description: This is an optional description for SEO and Open Graph purposes, rather than the default generated excerpt.
5
---
6
​
7
Far far away, behind the word mountains, far from the countries Vokalia and
8
Consonantia, there live the blind texts.
Copied!
We can see above that each blog post has a title, a date, a description and a body. Now, let's recreate this using Netlify CMS.

Add Netlify CMS to your site

First let's install some dependencies. We'll need netlify-cms-app and gatsby-plugin-netlify-cms. Run the following command in the terminal at the root of your site:
1
npm install --save netlify-cms-app gatsby-plugin-netlify-cms
Copied!

Configuration

For the purpose of this guide we will deploy to Netlify from a GitHub repository which requires the minimum configuration.
Create a config.yml file in the directory structure you see below:
1
├── static
2
│ ├── admin
3
│ │ ├── config.yml
Copied!
In your config.yml file paste the following configuration:
1
backend:
2
name: git-gateway
3
branch: main # Branch to update (optional; defaults to master)
4
​
5
media_folder: static/img
6
public_folder: /img
7
​
8
collections:
9
- name: 'blog'
10
label: 'Blog'
11
folder: 'content/blog'
12
create: true
13
slug: 'index'
14
media_folder: ''
15
public_folder: ''
16
path: '{{title}}/index'
17
editor:
18
preview: false
19
fields:
20
- { label: 'Title', name: 'title', widget: 'string' }
21
- { label: 'Publish Date', name: 'date', widget: 'datetime' }
22
- { label: 'Description', name: 'description', widget: 'string' }
23
- { label: 'Body', name: 'body', widget: 'markdown' }
Copied!
Note: The above configuration allows assets to be stored relative to their content. Therefore posts would be stored in the format below as it is in gatsby-starter-blog.
1
content/
2
├── blog
3
│ ├── first-post-title
4
│ │ ├── index.md
5
│ │ └── post-image.jpg
6
└── └── second-post-title
7
├── index.md
8
└── post-image.jpg
Copied!
Finally, add the plugin to your gatsby-config.js.
1
plugins: [`gatsby-plugin-netlify-cms`]
Copied!

Push to GitHub

It's now time to commit your changes and push to GitHub. The Gatsby starter initializes Git automatically for you, so you only need to do:
1
git add .
2
git commit -m "Initial Commit"
3
git remote add origin https://github.com/YOUR_USERNAME/NEW_REPO_NAME.git
4
git push -u origin main
Copied!

Add your repo to Netlify

Go to Netlify and select 'New Site from Git'. Select GitHub and the repository you just pushed to. Click Configure Netlify on GitHub and give access to your repository. Finish the setup by clicking Deploy Site. Netlify will begin reading your repository and starting building your project.

Enable Identity and Git Gateway

Netlify's Identity and Git Gateway services allow you to manage CMS admin users for your site without requiring them to have an account with your Git host or commit access on your repo. From your site dashboard on Netlify:
  1. 1.
    Go to Settings > Identity, and select Enable Identity service.
  2. 2.
    Under Registration preferences, select Open or Invite only. In most cases, you want only invited users to access your CMS, but if you're just experimenting, you can leave it open for convenience.
  3. 3.
    If you'd like to allow one-click login with services like Google and GitHub, check the boxes next to the services you'd like to use, under External providers.
  4. 4.
    Scroll down to Services > Git Gateway, and click Enable Git Gateway. This authenticates with your Git host and generates an API access token. In this case, we're leaving the Roles field blank, which means any logged in user may access the CMS. For information on changing this, check the Netlify Identity documentation.

Start publishing

It's time to create your first blog post. Login to your site's /admin/ page and create a new post by clicking New Blog. Add a title, a date and some text. When you click Publish, a new commit will be created in your GitHub repo with this format Create Blog “year-month-date-title”.
Then Netlify will detect that there was a commit in your repo, and will start rebuilding your project. When your project is deployed you'll be able to see the post you created.

Cleanup

It is now safe to remove the default Gatsby blog posts.

About the GraphQL API

The GitHub GraphQL API offers flexibility and the ability to define precisely the data you want to fetch.

Overview

Here are some quick links to get you up and running with the GraphQL API v4:

About GraphQL

The GraphQL data query language is:
  • A specification. The spec determines the validity of the schema on the API server. The schema determines the validity of client calls.
  • ​Strongly typed. The schema defines an API's type system and all object relationships.
  • ​Introspective. A client can query the schema for details about the schema.
  • ​Hierarchical. The shape of a GraphQL call mirrors the shape of the JSON data it returns. Nested fields let you query for and receive only the data you specify in a single round trip.
  • An application layer. GraphQL is not a storage model or a database query language. The graph refers to graph structures defined in the schema, where nodes define objects and edges define relationships between objects. The API traverses and returns application data based on the schema definitions, independent of how the data is stored.

Why GitHub is using GraphQL

GitHub chose GraphQL for our API v4 because it offers significantly more flexibility for our integrators. The ability to define precisely the data you want—and only the data you want—is a powerful advantage over the REST API v3 endpoints. GraphQL lets you replace multiple REST requests with a single call to fetch the data you specify.
For more details about why GitHub has moved to GraphQL, see the original announcement blog post.

About the GraphQL schema reference

The docs in the sidebar are generated from the GitHub GraphQL schema. All calls are validated and executed against the schema. Use these docs to find out what data you can call:
You can access this same content via the Explorer Docs sidebar. Note that you may need to rely on both the docs and the schema validation to successfully call the GraphQL API.
For other information, such as authentication and rate limit details, check out the guides.

Requesting support

For questions, bug reports, and discussions about GitHub Apps, OAuth Apps, and API development, explore the GitHub API Development and Support Forum. The forum is moderated and maintained by GitHub staff, but questions posted to the forum are not guaranteed to receive a reply from GitHub staff.
Consider reaching out to GitHub Support directly using the contact form for:
  • guaranteed response from GitHub staff
  • support requests involving sensitive data or private concerns
  • feature requests
  • feedback about GitHub products

Overview

A backend is JavaScript code that allows Netlify CMS to communicate with a service that stores content - typically a Git host like GitHub or GitLab. It provides functions that Netlify CMS can use to do things like read and update files using API's provided by the service.

Backend Configuration

Individual backends should provide their own configuration documentation, but there are some configuration options that are common to multiple backends. A full reference is below. Note that these are properties of the backend field, and should be nested under that field.
Field
Default
Description
repo
none
Required for github, gitlab, and bitbucket backends; ignored by git-gateway. Follows the pattern [org-or-username]/[repo-name].
branch
master
The branch where published content is stored. All CMS commits and PRs are made to this branch.
api_root
https://api.github.com (GitHub), https://gitlab.com/api/v4 (GitLab), or https://api.bitbucket.org/2.0 (Bitbucket)
The API endpoint. Only necessary in certain cases, like with GitHub Enterprise or self-hosted GitLab.
site_domain
location.hostname (or cms.netlify.com when on localhost)
Sets the site_id query param sent to the API endpoint. Non-Netlify auth setups will often need to set this for local development to work properly.
base_url
https://api.netlify.com (GitHub, Bitbucket) or https://gitlab.com (GitLab)
OAuth client hostname (just the base domain, no path). Required when using an external OAuth server or self-hosted GitLab.
auth_endpoint
auth (GitHub, Bitbucket) or oauth/authorize (GitLab)
Path to append to base_url for authentication requests. Optional.
cms_label_prefix
netlify-cms/
Pull (or Merge) Requests label prefix when using editorial workflow. Optional.

Creating a New Backend

Anyone can write a backend, but we don't yet have a finalized and documented API. If you would like to write your own backend for a service that does not have one currently, we recommend using the GitHub backend as a reference for API and best practices.

Creating Custom Widgets

The NetlifyCMS exposes a window.CMS a global object that you can use to register custom widgets, previews, and editor plugins. The same object is also the default export if you import Netlify CMS as an npm module. The available widget extension methods are:
  • registerWidget: registers a custom widget.
  • registerEditorComponent: adds a block component to the Markdown editor.

Writing React Components inline

The registerWidget requires you to provide a React component. If you have a build process in place for your project, it is possible to integrate with this build process.
However, although possible, it may be cumbersome or even impractical to add a React build phase. For this reason, NetlifyCMS exposes two constructs globally to allow you to create components inline: ‘createClass’ and ‘h’ (alias for React.createElement).

registerWidget

Register a custom widget.
1
// Using global window object
2
CMS.registerWidget(name, control, [preview], [schema]);
3
​
4
// Using npm module import
5
import CMS from 'netlify-cms';
6
CMS.registerWidget(name, control, [preview], [schema]);
Copied!
Params:
Param
Type
Description
name
string
Widget name, allows this widget to be used via the field widget property in config
control
React.Component or string
  • React component that renders the control, receives the following props:
    • value: Current field value
    • field: Immutable map of current field configuration
    • forID: Unique identifier for the field
    • classNameWrapper: class name to apply CMS styling to the field
    • onChange: Callback function to update the field value
  • Name of a registered widget whose control should be used (includes built in widgets).
[preview]
React.Component, optional
Renders the widget preview, receives the following props:
  • value: Current preview value
  • field: Immutable map of current field configuration
  • metadata: Immutable map of any available metadata for the current field
  • getAsset: Function for retrieving an asset url for image/file fields
  • entry: Immutable Map of all entry data
  • fieldsMetaData: Immutable map of metadata from all fields.
[schema]
JSON Schema object, optional
Enforces a schema for the widget's field configuration
Example:
admin/index.html
1
<script src="https://unpkg.com/[email protected]^2.0.0/dist/netlify-cms.js"></script>
2
<script>
3
var CategoriesControl = createClass({
4
handleChange: function(e) {
5
const separator = this.props.field.get('separator', ', ')
6
this.props.onChange(e.target.value.split(separator).map((e) => e.trim()));
7
},
8
​
9
render: function() {
10
const separator = this.props.field.get('separator', ', ');
11
var value = this.props.value;
12
return h('input', {
13
id: this.props.forID,
14
className: this.props.classNameWrapper,
15
type: 'text',
16
value: value ? value.join(separator) : '',
17
onChange: this.handleChange,
18
});
19
},
20
});
21
​
22
var CategoriesPreview = createClass({
23
render: function() {
24
return h('ul', {},
25
this.props.value.map(function(val, index) {
26
return h('li', {key: index}, val);
27
})
28
);
29
}
30
});
31
​
32
var schema = {
33
properties: {
34
separator: { type: 'string' },
35
},
36
}
37
​
38
CMS.registerWidget('categories', CategoriesControl, CategoriesPreview, schema);
39
</script>
Copied!
admin/config.yml
1
collections:
2
- name: posts
3
label: Posts
4
folder: content/posts
5
fields:
6
- name: title
7
label: Title
8
widget: string
9
- name: categories
10
label: Categories
11
widget: categories
12
separator: __
Copied!

registerEditorComponent

Register a block level component for the Markdown editor:
1
CMS.registerEditorComponent(definition)
Copied!
Params
  • definition: The component definition; must specify: id, label, fields, patterns, fromBlock, toBlock, toPreview
Example:
1
<script src="https://unpkg.com/[email protected]^2.0.0/dist/netlify-cms.js"></script>
2
<script>
3
CMS.registerEditorComponent({
4
// Internal id of the component
5
id: "collapsible-note",
6
// Visible label
7
label: "Collapsible Note",
8
// Fields the user need to fill out when adding an instance of the component
9
fields: [
10
{
11
name: 'summary',
12
label: 'Summary',
13
widget: 'string'
14
},
15
{
16
name: 'details',
17
label: 'Details',
18
widget: 'markdown'
19
}
20
],
21
// Regex pattern used to search for instances of this block in the markdown document.
22
// Patterns are run in a multline environment (against the entire markdown document),
23
// and so generally should make use of the multiline flag (`m`). If you need to capture
24
// newlines in your capturing groups, you can either use something like
25
// `([\S\s]*)`, or you can additionally enable the "dot all" flag (`s`),
26
// which will cause `(.*)` to match newlines as well.
27
//
28
// Additionally, it's recommended that you use non-greedy capturing groups (e.g.
29
// `(.*?)` vs `(.*)`), especially if matching against newline characters.
30
pattern: /^<details>$\s*?<summary>(.*?)<\/summary>\n\n(.*?)\n^<\/details>$/ms,
31
// Given a RegExp Match object
32
// (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/match#return_value),
33
// return an object with one property for each field defined in `fields`.
34
//
35
// This is used to populate the custom widget in the markdown editor in the CMS.
36
fromBlock: function(match) {
37
return {
38
summary: match[1],
39
detail: match[2]
40
};
41
},
42
// Given an object with one property for each field defined in `fields`,
43
// return the string you wish to be inserted into your markdown.
44
//
45
// This is used to serialize the data from the custom widget to the
46
// markdown document
47
toBlock: function(data) {
48
return `
49
<details>
50
<summary>${data.summary}</summary>
51
​
52
${data.detail}
53
​
54
</details>
55
`;
56
},
57
// Preview output for this component. Can either be a string or a React component
58
// (component gives better render performance)
59
toPreview: function(data) {
60
return `
61
<details>
62
<summary>${data.summary}</summary>
63
​
64
${data.detail}
65
​
66
</details>
67
`;
68
}
69
});
70
</script>
Copied!
Result:
![youtube-widget](/img/screen shot 2018-01-05 at 4.25.07 pm.png)

Advanced field validation

All widget fields, including those for built-in widgets, include basic validation capability using the required and pattern options.
With custom widgets, the widget control can also optionally implement an isValid method to perform custom validations, in addition to presence and pattern. The isValid method will be automatically called, and it can return either a boolean value, an object with an error message or a promise. Examples:
Boolean No errors:
1
isValid = () => {
2
// Do internal validation
3
return true;
4
};
Copied!
Existing error:
1
isValid = () => {
2
// Do internal validation
3
return false;
4
};
Copied!
Object with error (useful for returning custom error messages) Existing error:
1
isValid = () => {
2
// Do internal validation
3
return { error: { message: 'Your error message.' } };
4
};
Copied!
Promise You can also return a promise from isValid. While the promise is pending, the widget will be marked as "in error". When the promise resolves, the error is automatically cleared.
1
isValid = () => {
2
return this.existingPromise;
3
};
Copied!
Note: Do not create a promise inside isValid - isValid is called right before trying to persist. This means that even if a previous promise was already resolved, when the user hits 'save', isValid will be called again. If it returns a new promise, it will be immediately marked as "in error" until the new promise resolves.

Writing custom widgets as a separate package

Widgets are inputs for the Netlify CMS editor interface. It's a React component that receives user input and outputs a serialized value. Those are the only rules - the component can be extremely simple, like text input, or extremely complicated, like a full-blown markdown editor. They can make calls to external services, and generally do anything that JavaScript can do.
For writing custom widgets as a separate package you should follow these steps:
  1. 1.
    Create a directory
    1
    mkdir my-custom-widget
    Copied!
  2. 2.
    Navigate to the directory
    1
    cd my-custom-widget
    Copied!
  3. 3.
    For setting up a new npm package run this command:
    1
    npm init
    Copied!
  4. 4.
    Answer the questions in the command line questionnaire.
  5. 5.
    In order to build React components, we need to set up a build step. We'll be using Webpack. Please run the following commands to install the required dependencies:
1
npm install --save-dev [email protected] babel-core babel-plugin-transform-class-properties babel-plugin-transform-export-extensions babel-plugin-transform-object-rest-spread babel-preset-env babel-preset-react cross-env css-loader html-webpack-plugin netlify-cms react source-map-loader style-loader webpack webpack-cli webpack-serve
Copied!
1
npm install --save prop-types
Copied!
And you should manually add "peerDependencies" and "scripts" as shown below.
Here is the content of package.json that you will have at the end:
1
{
2
"name": "netlify-cms-widget-starter",
3
"description": "A boilerplate for creating Netlify CMS widgets.",
4
"author": "name of developer",
5
"keywords": [
6
"netlify",
7
"netlify-cms",
8
"cms",
9
"widget",
10
"starter",
11
"boilerplate"
12
],
13
"version": "0.0.1",
14
"homepage": "https://github.com/netlify/netlify-cms-widget-starter",
15
"license": "MIT",
16
"main": "dist/main.js",
17
"devDependencies": {
18
"babel-loader": "^7.1.4",
19
"babel-plugin-transform-class-properties": "^6.24.1",
20
"babel-plugin-transform-export-extensions": "^6.22.0",
21
"babel-plugin-transform-object-rest-spread": "^6.26.0",
22
"babel-preset-env": "^1.6.1",
23
"babel-preset-react": "^6.24.1",
24
"cross-env": "^5.1.4",
25
"css-loader": "^0.28.11",
26
"html-webpack-plugin": "^3.2.0",
27
"netlify-cms": "^1.5.0",
28
"react": "^16.3.2",
29
"source-map-loader": "^0.2.3",
30
"style-loader": "^0.20.3",
31
"webpack": "^4.6.0",
32
"webpack-cli": "^2.0.14",
33
"webpack-serve": "^0.3.1"
34
},
35
"dependencies": {
36
"prop-types": "^15.6.1"
37
},
38
"peerDependencies": {
39
"react": "^16"
40
},
41
"scripts": {
42
"start": "webpack-serve --static public --open"
43
}
44
}
Copied!
  1. 1.
    Create a Webpack configuration file with this content:
    webpack.config.js
    1
    const path = require('path')
    2
    const HtmlWebpackPlugin = require('html-webpack-plugin')
    3
    ​
    4
    const developmentConfig = {
    5
    mode: 'development',
    6
    entry: './dev/index.js',
    7
    output: {
    8
    path: path.resolve(__dirname, 'public'),
    9
    },
    10
    optimization: { minimize: false },
    11
    module: {
    12
    rules: [
    13
    {
    14
    test: /\.js$/,
    15
    loader: 'source-map-loader',
    16
    enforce: 'pre',
    17
    },
    18
    {
    19
    test: /\.jsx?$/,
    20
    exclude: /node_modules/,
    21
    loader: 'babel-loader',
    22
    },
    23
    {
    24
    test: /\.css$/,
    25
    use: [{ loader: 'style-loader' }, { loader: 'css-loader' }],
    26
    },
    27
    ],
    28
    },
    29
    plugins: [
    30
    new HtmlWebpackPlugin(),
    31
    ],
    32
    devtool: 'eval-source-map',
    33
    }
    34
    ​
    35
    const productionConfig = {
    36
    mode: 'production',
    37
    module: {
    38
    rules: [
    39
    {
    40
    test: /\.jsx?$/,
    41
    loader: 'babel-loader',
    42
    },
    43
    ],
    44
    },
    45
    devtool: 'source-map',
    46
    }
    47
    ​
    48
    module.exports = process.env.NODE_ENV === 'production' ? productionConfig : developmentConfig
    Copied!
  2. 2.
    The .babelrc file is our local configuration for our code in the project. You should create it under the root of the application repo. It will affect all files that Babel processes. So, create a .babelrc file under the main project with this content:
1
{
2
"presets": [
3
"react",
4
"env",
5
],
6
"plugins": [
7
"transform-export-extensions",
8
"transform-class-properties",
9
"transform-object-rest-spread",
10
],
11
}
Copied!
  1. 1.
    Create a src directory with the files Control.js, Preview.js and index.js
src/Control.js
1
import PropTypes from 'prop-types';
2
import React from 'react';
3
​
4
export default class Control extends React.Component {
5
static propTypes = {
6
onChange: PropTypes.func.isRequired,
7
forID: PropTypes.string,
8
value: PropTypes.node,
9
classNameWrapper: PropTypes.string.isRequired,
10
}
11
​
12
static defaultProps = {
13
value: '',
14
}
15
​
16
render() {
17
const {
18
forID,
19
value,
20
onChange,
21
classNameWrapper,
22
} = this.props;
23
​
24
return (
25
<input
26
type="text"
27
id={forID}
28
className={classNameWrapper}
29
value={value || ''}
30
onChange={e => onChange(e.target.value)}
31
/>
32
);
33
}
34
}
Copied!
src/Preview.js
1
import PropTypes from 'prop-types';
2
import React from 'react';
3
​
4
export default function Preview({ value }) {
5
return <div>{ value }</div>;
6
}
7
​
8
Preview.propTypes = {
9
value: PropTypes.node,
10
};
Copied!
src/index.js
1
import Control from './Control'
2
import Preview from './Preview'
3
​
4
if (typeof window !== 'undefined') {
5
window.Control = Control
6
window.Preview = Preview
7
}
8
​
9
export { Control, Preview }
Copied!
  1. 1.
    Now you need to set up the locale example site. Under the main project, create a dev directory with the files bootstrap.js and index.js
bootstrap.js
1
window.CMS_MANUAL_INIT = true
Copied!
index.js
1
import './bootstrap.js'
2
import CMS, { init } from 'netlify-cms'
3
import 'netlify-cms/dist/cms.css'
4
import { Control, Preview } from '../src'
5
​
6
const config = {
7
backend: {
8
name: 'test-repo',
9
login: false,
10
},
11
media_folder: 'assets',
12
collections: [{
13
name: 'test',
14
label: 'Test',
15
files: [{
16
file: 'test.yml',
17
name: 'test',
18
label: 'Test',
19
fields: [
20
{ name: 'test_widget', label: 'Test Widget', widget: 'test'},
21
],
22
}],
23
}],
24
}
25
​
26
CMS.registerWidget('test', Control, Preview)
27
​
28
init({ config })
Copied!

Development

To run a copy of Netlify CMS with your widget for development, use the start script:
1
npm start
Copied!
Your widget source is in the src directory, where there are separate files for the Control and Preview components.

Production & Publishing

You'll want to take a few steps before publishing a production built package to npm:
  1. 1.
    Customize package.json with details for your specific widget, e.g. name, description, author, version, etc.
    1
    {
    2
    "name": "netlify-cms-widget-starter",
    3
    "description": "A boilerplate for creating Netlify CMS widgets.",
    4
    "author": "name of developer",
    5
    "keywords": [
    6
    "netlify",
    7
    "netlify-cms",
    8
    "cms",
    9
    "widget",
    10
    "starter",
    11
    "boilerplate"
    12
    ],
    13
    "version": "0.0.1",
    14
    // ... rest
    15
    }
    Copied!
  2. 2.
    For discoverability, ensure that your package name follows the pattern netlify-cms-widget-<name>.
  3. 3.
    Delete this README.md, rename README_TEMPLATE.md to README.md, and update the new file for your specific widget.
  4. 4.
    Rename the exports in src/index.js. For example, if your widget is netlify-cms-widget-awesome, you would do:
1
if (typeof window !== 'undefined') {
2
window.AwesomeControl = Control
3
window.AwesomePreview = Preview
4
}
5
​
6
export { Control as AwesomeControl, Preview as AwesomePreview }
Copied!
  1. 1.
    Optional: customize the component and file names in src.
  2. 2.
    If you haven't already, push your repo to your GitHub account so the source available to other developers.
  3. 3.
    Create a production build, which will be output to dist:
1
npm run build
Copied!
  1. 1.
    Finally, if you're sure things are tested and working, publish!
1
npm publish
Copied!
JavaScript - Previous
JS-Leetcode
Next - Web Development Frameworks & Libraries
React
Last modified 28m ago
Copy link
Contents
Gatsby (graphql)
Create a new Gatsby site
Get to know Gatsby
Add Netlify CMS to your site
Start publishing
About the GraphQL API
In this article
Overview
About GraphQL
Why GitHub is using GraphQL
About the GraphQL schema reference
Requesting support
Overview
Backend Configuration
Creating a New Backend
Creating Custom Widgets
registerWidget
registerEditorComponent
Advanced field validation
Writing custom widgets as a separate package